home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Textdisplayers / FullView / FullView.doc < prev    next >
Text File  |  1996-09-26  |  11KB  |  197 lines

  1.  
  2.                     --------------------------------------
  3.                     -           FullView v3.04           -
  4.                     -                                    -
  5.                     - (c) Copyright 1991 Jonathan Potter -
  6.                     --------------------------------------
  7.  
  8.                 -- See the bottom of this file for changes --
  9.  
  10.     FullView is a text viewer that offers fast, smooth-scrolling ANSI compatible text displays.
  11.  
  12.     FullView opens up to the full size of the Workbench screen (non-interlaced). Because there is no slider gadget at the side of the screen, you are able to view full 80 column text with a standard Workbench configuration (many text viewers only show 78 columns across).
  13.  
  14.     To start FullView from the CLI, simple type
  15.  
  16.         FullView filename
  17.  
  18.     or from the Workbench, double-click on a project icon that has FullView as its default tool.
  19.  
  20.     FullView will load text and pictures that have been crunched with PowerPacker, by Nico Francois.
  21.  
  22.     FullView has a built-in help screen that can instantly explain its functions, as well as remind you of the keyboard equivalent of many commands. However, here are brief instructions on the operation of the commands. They are listed with the command name (if this command is accessed from a menu, this is also the name of the menu item), and any keyboard equivalents the command may have.
  23.  
  24.         Load...        AMIGA-L or l key
  25.  
  26.         This command allows you to load a new text file using the built-in file requester. The file requester is similar to the Commodore ASL requester and to the ARP file requester, and thus most users should be familiar with its operation.
  27.  
  28.         Show Pic...    AMIGA-H or h key
  29.  
  30.         This command allows you to display an IFF ILBM picture file. A wide variety of formats is supported, including HAM, Overscan, EHB and Dynamic-HiRes.
  31.  
  32.         Save As...    AMIGA-V or v key
  33.  
  34.         This command allows you to save the currently displayed text file under a new name. This can also be useful for converting PowerPacker-crunched text into plain ASCII text.
  35.  
  36.         Print all    AMIGA-P or p key
  37.  
  38.         This command will print the current text file to the printer (PRT:).
  39.  
  40.         Print screen    AMIGA-C or c key
  41.  
  42.         This command will print the currently displayed page of text to the printer (PRT:).
  43.  
  44.         Search for...    AMIGA-S or s key
  45.  
  46.         This command allows you to search the current text file for a text string. Wildcard characters are not supported. The search takes place from the top of the currently displayed page.
  47.  
  48.         Repeat search    AMIGA-R or r key
  49.  
  50.         This command repeats the last text search, from the current position in the file.
  51.  
  52.         About
  53.  
  54.         This function displays some information about the program, including version number and how to contact the author.
  55.  
  56.         Help        HELP key
  57.  
  58.         This function displays a brief list of commands and their keyboard equivalents.
  59.  
  60.         Iconify        AMIGA-I or i key
  61.  
  62.         This command closes the FullView screen and opens a small window on the Workbench screen. This allows you to keep your text file in memory and refer to it at any time, but saves on memory when it is not actually being accessed. To return to the text file, click where the iconified window tells you to. Clicking the close gadget will remove the text file from memory without returning.
  63.  
  64.         Quit        AMIGA-Q or qx, or ESCape key
  65.  
  66.         This command will remove FullView from memory.
  67.  
  68.         Auto scroll    SPACE bar or left mouse button
  69.  
  70.         FullView will auto-scroll text at four different speeds. The speed is determined by the vertical position of the mouse; the center of the screen is "neutral", and the further away from the center you move the mouse, the faster FullView will scroll in that direction.
  71.  
  72.         To toggle auto-scrolling, either press the SPACE bar or press the left mouse button. The mouse pointer will disappear while FullView is auto-scrolling, and reappear when scrolling stops (when you either stop it manually or the text reaches the top or bottom).
  73.  
  74.         Line up        Cursor up key or /\ gadget
  75.  
  76.         This function scrolls one line up through the text. If you continue to hold down the key or the gadget, this function will repeat after a brief interval.
  77.  
  78.         Line down    Cursor down key or \/ gadget
  79.  
  80.         This function scrolls one line down through the text. If you continue to hold down the key or the gadget, this function will repeat after a brief interval.
  81.  
  82.         Page up        Shift + Cursor up key, u key or U gadget
  83.  
  84.         This function moves one full page up through the text.
  85.  
  86.         Page down    Shift + Cursor down key, d key or D gadget
  87.  
  88.         This function moves one full page down through the text.
  89.  
  90.         Top of text    Control + Cursor up key, t key or T gadget
  91.  
  92.         This function moves to the beginning of the current text file.
  93.  
  94.         Bottom of text    Control + Cursor down key, b key or B gadget
  95.  
  96.         This function moves to the end of the current text file.
  97.  
  98.         Jump to line    j key or line gadget
  99.  
  100.         This function allows you to jump to a specified line number. The line gadget is the number that displays the current line being viewed in the status bar at the bottom of the screen (xxxxx > yyyyy; it is the xxxxx value)
  101.  
  102.         Jump to percent    J key or percent gadget
  103.  
  104.         This function allows you to jump a specified percentage into the file. This percent gadget is the number that displays the current percentage of text being viewed in the status bar (xxx%)
  105.  
  106.  
  107.     IFF routines
  108.  
  109.     FullView can show many different IFF ILBM formats, including HAM, Overscan, Extra Half Brite, and Dynamic-HiRes. There are four main ways to show an IFF picture with FullView.
  110.  
  111.         a) Run FullView with no arguments, and select an IFF picture with
  112.            the file requester.
  113.  
  114.         b) Once FullView has loaded a text file, select the Show Pic...
  115.            command and select an IFF picture with the file requester.
  116.  
  117.         c) Run FullView from the CLI with the name of an IFF picture and
  118.            use the +p argument.
  119.  
  120.            The +p tells FullView that it is a picture you want to show,
  121.            not a text file to read. The +p goes on the command line, after
  122.            the filename. For example,
  123.  
  124.                FullView dh0:Picture.iff +p
  125.  
  126.         d) From the Workbench, specify FullView as the default tool of a
  127.            picture file, and add the ToolType :
  128.  
  129.                FILETYPE=ILBM
  130.  
  131.            This has the same effect as the +p argument from the CLI.
  132.  
  133.     When a picture is displayed, there are several key presses that do different things. You can turn the mouse pointer on or off with the . key. You can stop/start colour cycling (if the file has colour cycling information) with the TAB key. Pressing the p key will print the picture. If a picture is larger than the screen, you can scroll around it using the cursor keys; by themselves they move in single steps, in conjunction with Shift they move a page, and in conjunction with Control they move to the start (or end). To return from a displayed picture, press the left mouse button, or the q or ESCape key.
  134.  
  135.  
  136.     TAB size
  137.  
  138.     The default size of tab characters in FullView is 4 spaces. You may, if running from the Workbench, specify the tab size yourself. To do this, add the following ToolType to the project icon :
  139.  
  140.         TABSIZE=size
  141.  
  142.     size is the number of spaces a tab character is to be equivalent to, and may be any number from 1 to 10.
  143.  
  144.  
  145.     ANSI codes
  146.  
  147.     FullView supports the ANSI codes used to change colour and type style. Because of the way FullView displays its text, there is a limitation on the changing of colour and type style; the colour and style is reset at the start of every line. This should not cause any major problems, but it does mean that if you wanted a rectangle of colour, you would have to specify the ANSI codes for every line, instead of just at the start and end of the rectangle. An example of this is the rectangular header of this document file.
  148.  
  149.     For your information, the applicable ANSI codes are :
  150.  
  151.     0    reset                1    bold face
  152.     3    italic                4    underscore
  153.     7    inverse video
  154.  
  155.     30    foreground pen colour 0        40    background pen colour 0
  156.     31    foreground pen colour 1        41    background pen colour 1
  157.     32    foreground pen colour 2        42    background pen colour 2
  158.     33    foreground pen colour 3        43    background pen colour 3
  159.  
  160.     ANSI codes are included in text using an escape code. This code looks like :
  161.  
  162.         <CSI>code[;code[;code]]m
  163.  
  164.     CSI is the Control Sequence Introducer, and it consists of an ESCape character and a [ character. For instance, to set the foreground colour to pen colour 2, the background colour to pen colour 3, and the style to italics and underscore, the control sequence would be :
  165.  
  166.         [[32;43;3;4m
  167.  
  168.         And here it is!!!
  169.  
  170.     You do not need to specify the [[0m reset sequence at the end of every line, as colours and styles are reset automatically for each line.
  171.  
  172.  
  173.     Word wrapping
  174.  
  175.     FullView will wrap-around to the next line any words that do not fit on the current line. This should normally not cause a problem. It could, however, cause trouble if FullView wraps words that are supposed to be a different colour and style. As colours and styles are reset for each line, any words that were wrapped would not be in the desired colour/style. There is no easy way out of this; all you can do is preview your text to make sure that this has not occurred. If it has, or you perceive it likely to happen, you can specify the escape code for each individual word. For instance,
  176.  
  177.         [[1mEach [[1mIndividual [[1mWord
  178.  
  179.  
  180.     Speaking of wrapping...
  181.  
  182.     That about wraps it up for this document file. FullView is largely self-explanatory, and I hope that I have covered all of the necessary points in this text. If you ever have trouble with FullView, please contact me at the address below.
  183.  
  184.     FullView is copyright, but is freely distributable. If you wish to use it in a commercial venture, however, you must contact me.
  185.  
  186.  
  187.                                Jonathan Potter
  188.                                  P.O. Box 289
  189.                               Goodwood, SA 5034
  190.                                   Australia
  191.  
  192.                              Phone : (08) 2932788
  193.                               Fax : (08) 2938941
  194.  
  195.                              FidoNET : 3:680/829
  196.                     Internet : jpotter@itd.adelaide.edu.au
  197.